<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libcoap: bits.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">libcoap<span id="projectnumber">&#160;4.2.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('bits_8h.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle"><div class="title">bits.h File Reference</div></div>
</div><!--header-->
<div class="contents">

<p>Bit vector manipulation.  
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="bits_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a946f02faba6dbf0467c749390c946a2c" id="r_a946f02faba6dbf0467c749390c946a2c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bits_8h.html#a946f02faba6dbf0467c749390c946a2c">bits_setb</a> (<a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *vec, size_t size, <a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> bit)</td></tr>
<tr class="memdesc:a946f02faba6dbf0467c749390c946a2c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the bit <code>bit</code> in bit-vector <code>vec</code>.  <br /></td></tr>
<tr class="separator:a946f02faba6dbf0467c749390c946a2c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a90bd0ca65f01d997c25071f09a7c3e79" id="r_a90bd0ca65f01d997c25071f09a7c3e79"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bits_8h.html#a90bd0ca65f01d997c25071f09a7c3e79">bits_clrb</a> (<a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *vec, size_t size, <a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> bit)</td></tr>
<tr class="memdesc:a90bd0ca65f01d997c25071f09a7c3e79"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clears the bit <code>bit</code> from bit-vector <code>vec</code>.  <br /></td></tr>
<tr class="separator:a90bd0ca65f01d997c25071f09a7c3e79"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5933d85a7155fe929d19b0752db38ebf" id="r_a5933d85a7155fe929d19b0752db38ebf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="bits_8h.html#a5933d85a7155fe929d19b0752db38ebf">bits_getb</a> (const <a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *vec, size_t size, <a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> bit)</td></tr>
<tr class="memdesc:a5933d85a7155fe929d19b0752db38ebf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the status of bit <code>bit</code> from bit-vector <code>vec</code>.  <br /></td></tr>
<tr class="separator:a5933d85a7155fe929d19b0752db38ebf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Bit vector manipulation. </p>

<p class="definition">Definition in file <a class="el" href="bits_8h_source.html">bits.h</a>.</p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a90bd0ca65f01d997c25071f09a7c3e79" name="a90bd0ca65f01d997c25071f09a7c3e79"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a90bd0ca65f01d997c25071f09a7c3e79">&#9670;&#160;</a></span>bits_clrb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int bits_clrb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
          <td class="paramname"><em>vec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
          <td class="paramname"><em>bit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Clears the bit <code>bit</code> from bit-vector <code>vec</code>. </p>
<p>This function returns <code>1</code> if bit was cleared or <code>-1</code> on error (i.e. when the given bit does not fit in the vector).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vec</td><td>The bit-vector to change. </td></tr>
    <tr><td class="paramname">size</td><td>The size of <code>vec</code> in bytes. </td></tr>
    <tr><td class="paramname">bit</td><td>The bit to clear from <code>vec</code>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>-1</code> if <code>bit</code> does not fit into <code>vec</code>, <code>1</code> otherwise. </dd></dl>

<p class="definition">Definition at line <a class="el" href="bits_8h_source.html#l00052">52</a> of file <a class="el" href="bits_8h_source.html">bits.h</a>.</p>

</div>
</div>
<a id="a5933d85a7155fe929d19b0752db38ebf" name="a5933d85a7155fe929d19b0752db38ebf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5933d85a7155fe929d19b0752db38ebf">&#9670;&#160;</a></span>bits_getb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int bits_getb </td>
          <td>(</td>
          <td class="paramtype">const <a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
          <td class="paramname"><em>vec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
          <td class="paramname"><em>bit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Gets the status of bit <code>bit</code> from bit-vector <code>vec</code>. </p>
<p>This function returns <code>1</code> if the bit is set, <code>0</code> otherwise (even in case of an error).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vec</td><td>The bit-vector to read from. </td></tr>
    <tr><td class="paramname">size</td><td>The size of <code>vec</code> in bytes. </td></tr>
    <tr><td class="paramname">bit</td><td>The bit to get from <code>vec</code>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>1</code> if the bit is set, <code>0</code> otherwise. </dd></dl>

<p class="definition">Definition at line <a class="el" href="bits_8h_source.html#l00071">71</a> of file <a class="el" href="bits_8h_source.html">bits.h</a>.</p>

</div>
</div>
<a id="a946f02faba6dbf0467c749390c946a2c" name="a946f02faba6dbf0467c749390c946a2c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a946f02faba6dbf0467c749390c946a2c">&#9670;&#160;</a></span>bits_setb()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="libcoap_8h.html#a58b4446dccd0b8c21b3532ef6b77a57d">COAP_STATIC_INLINE</a> int bits_setb </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a> *&#160;</td>
          <td class="paramname"><em>vec</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">size_t&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="uthash_8h.html#aba7bc1797add20fe3efdf37ced1182c5">uint8_t</a>&#160;</td>
          <td class="paramname"><em>bit</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sets the bit <code>bit</code> in bit-vector <code>vec</code>. </p>
<p>This function returns <code>1</code> if bit was set or <code>-1</code> on error (i.e. when the given bit does not fit in the vector).</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">vec</td><td>The bit-vector to change. </td></tr>
    <tr><td class="paramname">size</td><td>The size of <code>vec</code> in bytes. </td></tr>
    <tr><td class="paramname">bit</td><td>The bit to set in <code>vec</code>.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><code>-1</code> if <code>bit</code> does not fit into <code>vec</code>, <code>1</code> otherwise. </dd></dl>

<p class="definition">Definition at line <a class="el" href="bits_8h_source.html#l00032">32</a> of file <a class="el" href="bits_8h_source.html">bits.h</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_a14d23a24002734ac2a3b997119f008e.html">coap2</a></li><li class="navelem"><a class="el" href="bits_8h.html">bits.h</a></li>
    <li class="footer">Generated on Fri Dec 27 2024 09:57:44 for libcoap by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
  </ul>
</div>
</body>
</html>
